Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI #15340

tienifr · 2023-02-22T02:57:06Z

Details

We are using htmlDecode when displaying the user name in the chat so when users enter HTML entities like &nbsp, it's not showing correctly

Fixed Issues

$ #15131
$ #15920
$ PROPOSAL: #15131 (comment)

Tests for issue #15131

Log in to account A and change the user name to &nbsp
Send some messages and send/request money to account B
Verify that the user name of account A is displayed correctly in all the reports, IOU messages and LHN in both accounts

Verify that no errors appear in the JS console

Tests for issue #15920

Open the app
Open any report
Type HTML entities like &nbsp and send the message
Verify that the message in LHN displays &nbsp

Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps issue #15131

Log in to account A and change the user name to &nbsp
Send some messages and send/request money to account B
Verify that the user name of account A is displayed correctly in all the reports, IOU messages and LHN in both accounts

Verify that no errors appear in the JS console

QA Steps issue #15920

Open the app
Open any report
Type HTML entities like &nbsp and send the message
Verify that the message in LHN displays &nbsp

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos for both issues

Web

web.4.mp4

Mobile Web - Chrome

chorme.mp4

Mobile Web - Safari

safari.2.mp4

Desktop

desktop.1.mp4

iOS

ios.1.mp4

Android

android.3.1.mp4

MelvinBot · 2023-02-22T03:59:20Z

@pecanoro @sobitneupane One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

sobitneupane

Browser Notification still has the issue.

src/libs/SidebarUtils.js

yuwenmemon · 2023-03-01T02:34:59Z

@pecanoro should we be CP-ing this to Staging?

sobitneupane · 2023-03-01T03:06:55Z

@tienifr Can you please retest and update screenshots in PR body? I am not getting expected results at all.

tienifr · 2023-03-01T03:08:29Z

@tienifr Can you please retest and update screenshots in PR body? I am not getting expected results at all.

@sobitneupane Sure, I am working on it

sobitneupane · 2023-03-01T03:44:59Z

@tienifr Looks like the PR at the backend is in staging(https://staging.new.expensify.com/). So, changes are not yet reflected on production(https://new.expensify.com/).

We might have to wait for the PR at the backend to hit production before testing.

tienifr · 2023-03-01T03:48:14Z

@sobitneupane We can update the backend URL in the code to the URL of the staging server to test

sobitneupane · 2023-03-01T03:52:23Z

@sobitneupane We can update the backend URL in the code to the URL of the staging server to test

I think we are having some issues while updating the backend URL in the code: https://expensify.slack.com/archives/C01GTK53T8Q/p1677569083684259. If it works for you, you can test it and let me know once done.

tienifr · 2023-03-01T04:46:57Z

@sobitneupane I just update the body of this PR. About updating the URL of the staging server to test:

For Web: Update the host in proxy like below

2. For Mobile Apps and Desktop: Update the expensifyURL in the CONFIG.js like below

sobitneupane · 2023-03-01T10:33:26Z

@tienifr
This is the mail I received on request money. I was expecting "Requested NPR 1.00 from &#38 sobit" but I got "Requested NPR 1.00 from &#38 sobit"

sobitneupane · 2023-03-01T10:45:58Z

@tienifr Can you please test Push Notifications (native) as well? I am not sure how can I test it on dev.

Please include mail notification, browser notification and push notifications screenshots as well.

sobitneupane · 2023-03-01T10:47:02Z

src/libs/ReportUtils.js

@@ -883,7 +883,8 @@ function buildOptimisticIOUReport(ownerEmail, userEmail, total, chatReportID, cu
 */
 function getIOUReportActionMessage(type, total, participants, comment, currency, paymentType = '', isSettlingUp = false) {
    const amount = NumberFormatUtils.format(preferredLocale, total / 100, {style: 'currency', currency});
-    const displayNames = _.map(participants, participant => getDisplayNameForParticipant(participant.login, true));
+    const parser = new ExpensiMark();
+    const displayNames = _.map(participants, participant => parser.replace(getDisplayNameForParticipant(participant.login, true)));


Similar to the above change, We should parse comment (optional message) as well.

@sobitneupane I have pushed a new commit. Please help me check it. Thank you!

sobitneupane

Yet to pass Mail Notifications test and Push Notifications test

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Browser Notification

tienifr · 2023-03-01T15:59:55Z

@sobitneupane Thanks for your review. I think sending mail notification is the work from BE side, and in order to test push notification on native device, we have to build app on physical device. Please correct me if I'm wrong.

tienifr · 2023-03-21T18:57:39Z

@sobitneupane @pecanoro After my update:

display name + IOU message in chat: correct

display name + IOU message in LHN: correct

display name + IOU message in Details: correct

display name + IOU message in BrowserNotifications: correct

sobitneupane

Screenshots/Videos

Web

LHN

Chat

Chat Offline

IOU Details RHN

Browser Notification

Mobile Web - Chrome

LHN

Chat

IOU Details RHN

Mobile Web - Safari

LHN

Chat

IOU Details RHN

Desktop

LHN

Chat

IOU Details RHN

iOS

LHN

Chat

Chat Offline

IOU Details RHN

Android

LHN

Chat

IOU Details RHN

sobitneupane

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

tienifr · 2023-03-22T13:31:59Z

Hi @pecanoro, please help check my lastest comment. Thank you!

tienifr · 2023-03-24T14:30:29Z

Hi @pecanoro Please help me check whether we are good to merge or not.

tienifr · 2023-03-27T12:14:27Z

Hi @sobitneupane @pecanoro I resolved the conflict and updated the code. Please help me review. Thank you!

tienifr · 2023-03-28T08:36:26Z

@sobitneupane I just resolved conflict, please help to approve again

mountiny

This is looking goof to me @tienifr it also fixed this issue #15920 can you please link it to the PR body and include tests/ QA steps to cover the linked issue too?

@pecanoro I think @sobitneupane has already tested and approved, all yours!

tienifr · 2023-03-28T09:43:59Z

@mountiny I just updated
cc @sobitneupane @pecanoro

pecanoro · 2023-03-28T10:06:45Z

Sorry guys, I was on vacation for a few days, I will final review and test this today.

pecanoro · 2023-03-28T10:35:56Z

Just tested it! It seems to be working well! I hope we got all the weird cases!

OSBotify · 2023-03-28T10:42:03Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-03-28T18:12:41Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.2.91-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-03-29T17:48:59Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.91-1 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

eh2077 · 2023-03-31T09:59:47Z

src/components/ReportActionItem/IOUQuote.js

                    </Text>
                    <Text style={[styles.chatItemMessage, props.shouldAllowViewDetails
                        ? styles.cursorPointer
                        : styles.cursorDefault]}
                    >
                        {/* Get remainder of IOU message */}
-                        {Str.htmlDecode(fragment.text.substring(fragment.text.indexOf(' ')))}
+                        {fragment.text.substring(fragment.text.indexOf(' '))}


This causes a regression on staging https://staging.new.expensify.com when cancelling a money request with IOU message contains special html characters. See https://expensify.slack.com/archives/C049HHMV9SM/p1680254182283689

@pecanoro @sobitneupane @tienifr Should we fix this before it's deployed to production?

Yeah, we should

Oh it's already in production

@eh2077 I was unable to reproduce the issue on staging v1.2.93-2. Can you try reproducing it again?

Did you try 1.2.93-4?

Oh yes. I was able to reproduce. @tienifr let's get this sorted asap.

@sobitneupane @pecanoro @eh2077 In

App/src/libs/actions/IOU.js

Line 556 in df10eeb

moneyRequestAction.originalMessage.comment,

we can use Str.htmlDecode(moneyRequestAction.originalMessage.comment) because moneyRequestAction.originalMessage.comment is encoded. What do you think?

fix: remove decode username

0290a79

tienifr marked this pull request as ready for review February 22, 2023 03:59

tienifr requested a review from a team as a code owner February 22, 2023 03:59

melvin-bot bot requested review from pecanoro and sobitneupane and removed request for a team February 22, 2023 03:59

fix: merge main

c93f6dc

tienifr mentioned this pull request Feb 22, 2023

[HOLD for payment 2023-04-26] [HOLD for payment 2023-04-21] [$1000] Special html characters like &nbsp are not escaped in name and can bug out the UI #15131

Closed

2 tasks

sobitneupane reviewed Feb 22, 2023

View reviewed changes

src/libs/SidebarUtils.js Outdated Show resolved Hide resolved

pecanoro changed the title ~~Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI~~ [HOLD web 36598] Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI Feb 27, 2023

pecanoro changed the title ~~[HOLD web 36598] Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI~~ Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI Feb 28, 2023

tienifr added 2 commits March 1, 2023 00:45

fix: decode IOU message

478f1aa

fix: merge main

3726b22

This was referenced Mar 1, 2023

[HOLD for payment 2023-03-13] [HOLD for payment 2023-03-09] IOU details - " " html tag is visible near currency abbreviation in IOU details #15576

Closed

Decode transaction messages because they may have HTML Entities #15578

Merged

tienifr added 2 commits March 1, 2023 08:43

fix: decode message in iou detail

87d4689

fix: merge main

b39a9f2

sobitneupane reviewed Mar 1, 2023

View reviewed changes

fix: remove Str.htmlDecode

7067ae8

tienifr dismissed stale reviews from sobitneupane and pecanoro via 7067ae8 March 21, 2023 18:53

sobitneupane reviewed Mar 22, 2023

View reviewed changes

sobitneupane previously approved these changes Mar 22, 2023

View reviewed changes

s77rt mentioned this pull request Mar 27, 2023

LHN- Message does not display correctly in LHN #16507

Closed

6 tasks

tienifr added 2 commits March 27, 2023 19:02

resolve conflict

663e909

remove htmlDecode applied on plaintext

6a0a7f9

tienifr dismissed sobitneupane’s stale review via 6a0a7f9 March 27, 2023 12:04

sobitneupane previously approved these changes Mar 28, 2023

View reviewed changes

merge main

335d87c

tienifr dismissed sobitneupane’s stale review via 335d87c March 28, 2023 08:32

mountiny assigned tienifr Mar 28, 2023

mountiny approved these changes Mar 28, 2023

View reviewed changes

mountiny mentioned this pull request Mar 28, 2023

[HOLD for payment 2023-04-05] [$1000] HTML entities like ' ' and '&lrm;' are converted to blank space in LHN #15920

Closed

6 tasks

pecanoro approved these changes Mar 28, 2023

View reviewed changes

pecanoro merged commit 9545850 into Expensify:main Mar 28, 2023

OSBotify mentioned this pull request Mar 28, 2023

Deploy Checklist: New Expensify 2023-03-28 #16632

Closed

30 tasks

eh2077 reviewed Mar 31, 2023

View reviewed changes

Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI #15340

Fix/15131: Special html characters like &nbsp are not escaped in name and can bug out the UI #15340

Conversation

tienifr commented Feb 22, 2023 • edited Loading

Details

Fixed Issues

Tests for issue #15131

Tests for issue #15920

Offline tests

QA Steps issue #15131

QA Steps issue #15920

PR Author Checklist

Screenshots/Videos for both issues

MelvinBot commented Feb 22, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

yuwenmemon commented Mar 1, 2023

sobitneupane commented Mar 1, 2023

tienifr commented Mar 1, 2023

sobitneupane commented Mar 1, 2023

tienifr commented Mar 1, 2023

sobitneupane commented Mar 1, 2023

tienifr commented Mar 1, 2023

sobitneupane commented Mar 1, 2023

sobitneupane commented Mar 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

tienifr commented Mar 1, 2023

tienifr commented Mar 21, 2023

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

tienifr commented Mar 22, 2023

tienifr commented Mar 24, 2023

tienifr commented Mar 27, 2023

tienifr commented Mar 28, 2023

mountiny left a comment

Choose a reason for hiding this comment

tienifr commented Mar 28, 2023

pecanoro commented Mar 28, 2023

pecanoro commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 28, 2023

OSBotify commented Mar 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr commented Feb 22, 2023 •

edited

Loading

sobitneupane commented Mar 1, 2023 •

edited

Loading

sobitneupane left a comment •

edited

Loading